Skip to content

[skip circleci] Update release instructions #2384

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Nov 24, 2021

Conversation

jneira
Copy link
Member

@jneira jneira commented Nov 22, 2021

  • Adding prerelease sanity checklist
  • Mention gitlab repo and its ci
  • The page is a litle bit messed, tempted to rewrite it completely. Hope @michaelpj will have some insights to improve it

@jneira jneira requested a review from michaelpj November 22, 2021 07:56
@jneira
Copy link
Member Author

jneira commented Nov 22, 2021

Copy link
Collaborator

@michaelpj michaelpj left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I agree it's a pretty ferocious page, but it seems like there just is a lot to do! I don't have any great ideas for restructuring it.

- [ ] bump up versions of changed packages. All are optional but [haskell-language-server itself](https://github.com/haskell/haskell-language-server/blob/master/haskell-language-server.cabal).
- [ ] create the tag and make an initial prerelease to trigger the ci workflow (see details below)
- [ ] contact ghcup team (#haskell-ghcup irc channel or via its [repo](https://gitlab.haskell.org/haskell/ghcup-hs/-/issues)) to try to sync our release and its inclusion in ghcup
- [ ] check uploaded binaries (see windows note below) and the release description (usually the changelog entry) and uncheck the prerelease box
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

which uploaded binaries? where are they? I guess they were generated somewhere based on the previous workflows?

* [ ] create ${version}-hackage branch to trigger the hackage github workflow which will upload all changed packages to hackage as candidates
* [ ] check manually candidates in hackage
* [ ] publish them definitely
- [ ] bump up package versions following the [pvp specification](https://pvp.haskell.org/) if they are not already updated. You could use [policeman](https://github.com/kowainik/policeman) to help with this step.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

how is this different to the previous verison-bumping step on line 29? should there just be one version-bumping step done before any releasing?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The difference is in the All are optional but haskell-language-server itself part. For hackage bump up versions following pvp is mandatory. For the github release you only need to bump up hls itself.
At the beginning we did not have the github and hackage release in sync and we only bumped up plugin and package versions in a systematic way for the hackage one. In last releases i bumped up versions before start the release engine.

Co-authored-by: Michael Peyton Jones <[email protected]>
@jneira
Copy link
Member Author

jneira commented Nov 23, 2021

I agree it's a pretty ferocious page, but it seems like there just is a lot to do! I don't have any great ideas for restructuring it.

I see some repetition between the check list and the descriptions below but maybe it is necessary. Anyways it could be rewritten in an ongoing pr.

@jneira jneira added the merge me Label to trigger pull request merge label Nov 23, 2021
@jneira jneira changed the title Update release instructions [skip circleci] Update release instructions Nov 24, 2021
@mergify mergify bot merged commit 4b7d139 into haskell:master Nov 24, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge me Label to trigger pull request merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants